home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d20 / af_129.arc / AREAFIX.DOC next >
Text File  |  1991-12-06  |  46KB  |  1,213 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                               Areafix Revision 1.29
  10.  
  11.  
  12.  
  13.                         Originally Written by Greg Dawson
  14.  
  15.  
  16.  
  17.         (C) Copyright 1988-91 by Greg Dawson and George Peace (1:270/101).
  18.                                All Rights Reserved.
  19.  
  20.  
  21.  
  22.                                   December, 1991
  23.  
  24.      Areafix v1.29                                                     Page 2
  25.      ------------------------------------------------------------------------
  26.  
  27.  
  28.  
  29.                                    INTRODUCTION
  30.  
  31.  
  32.      Please look  over  the  documentation  carefully.  Though  most  of  the
  33.      commands have  not changed,  you might  rediscover some  old tricks that
  34.      have faded from memory with time.
  35.  
  36.      If you  are upgrading  from v1.10  to this  version you will need to add
  37.      your zone  number to  the "address" definition in Areafix.Ctl. All other
  38.      Areafix.Ctl directives  can remain  as they  were with v1.10. No changes
  39.      are required  to plug  in this  version if  you are upgrading from v1.20
  40.      though you might receive a benign Areafix.Ctl warning message.
  41.  
  42.  
  43.                               WHAT'S NEW SINCE 1.20?
  44.  
  45.  
  46.        *  AreaFix.Ctl accepts as many Password and Protect lines as available
  47.           memory will permit.
  48.  
  49.        *  Remote area deletion requests can be forwarded to your up-/down-
  50.           links.
  51.  
  52.        *  A default security profile can be assigned to areas with no Protect
  53.           entry in Areafix.Ctl.
  54.  
  55.        *  Lock/key security is available to supplement Password and Protect
  56.           security levels.
  57.  
  58.        *  Privilege masks are available to tailor Password entries.
  59.  
  60.        *  Dead-end passthru EchoMail areas can be purged from Areas.Bbs
  61.           automatically.
  62.  
  63.        *  Purge and remote deletion operations can be configured to remove
  64.           affected message subdirectories.
  65.  
  66.        *  Find and Query output (manual or remote) includes queued forward
  67.           request information.
  68.  
  69.        *  4-D addressing (zone:net/node.point) is supported throughout
  70.           Areafix.Ctl and Areas.Bbs.
  71.  
  72.        *  Notify messages can be generated for individual addresses.
  73.  
  74.        *  Remote requests that fail security checks are always saved.
  75.  
  76.        *  INTL kludge lines can be forced on all Areafix output messages.
  77.  
  78.        *  Areafix can assume alternate Zone: or Zone:Net identities for
  79.           multi-address environments.
  80.  
  81.      Areafix v1.29                                                     Page 3
  82.      ------------------------------------------------------------------------
  83.  
  84.  
  85.  
  86.        *  ShortForm and LongForm directives for Areas.Bbs format control have
  87.           been replaced by the Format directive. Format accepts one of three
  88.           choices: Short, Long, or Zone. Absence of a Format directive
  89.           implies "normal" Areas.Bbs format with zone information provided
  90.           where necessary and net number provided on all entries.
  91.  
  92.           Format Short   all entries are abbreciated to their shortest form
  93.           Format Long    all entries are expanded to include full notation
  94.           Format Zone    the first entry for each area always includes zone
  95.  
  96.  
  97.                               WHAT'S NEW SINCE 1.10?
  98.  
  99.  
  100.        *  AreaFix is now "zone aware" using INTL or MSGID addressing
  101.           extensions. All addresses in AreaFix.Ctl and on the command line
  102.           now accept a zone number. Except for the "address" definition in
  103.           Areafix.Ctl zones are optional.
  104.  
  105.        *  AreaFix recognizes add/delete requests from "your" points using
  106.           MSGID or FMPT addressing extensions. AreaFix translates the point
  107.           format to/from pointnet/point.
  108.  
  109.        *  Configuration maximums have been expanded to more closely reflect
  110.           current processing needs.
  111.  
  112.        *  Command line switch -R is available to force a rescan when doing a
  113.           manual add.
  114.  
  115.        *  Forward requests are now limited to one per day for each
  116.           area/address combination to help limit uplink netmail area
  117.           flooding.
  118.  
  119.        *  Actual area names are now used for request processing in addition
  120.           to the original CRC16 method. This eliminates 'dupe CRC' problems
  121.           while retaining most of the speed advantage of CRC checking.
  122.  
  123.        *  NetMail responses with =many= add/delete requests no longer overrun
  124.           the 16k message buffer. Large responses are split into multiple
  125.           messages.
  126.  
  127.        *  A delete request for a non-existent echo no longer generates an
  128.           auto-request to your feed.
  129.  
  130.        *  A NetMail query (-Q) is no longer honored if the password is
  131.           incorrect.
  132.  
  133.        *  A netmail add request for a protected area returns an already
  134.           active response if the area is already active. The previous version
  135.           returned a misleading protected area rejection response.
  136.  
  137.        *  Forward list processing now recognizes the specified list format if
  138.           different from areas.bbs format.
  139.  
  140.      Areafix v1.29                                                     Page 4
  141.      ------------------------------------------------------------------------
  142.  
  143.  
  144.  
  145.                                COMMAND LINE OPTIONS
  146.  
  147.  
  148.                Areafix [<[EC] [FIND] [ADD] [DELETE] [NOTIFY] [QUERY] [DROP]
  149.                [REMOTEAREADELETE]>] [<node>] [<echo(s)>] [-c<Areafix.Ctl>] [-
  150.                a<Areas.Bbs>]
  151.                [-h<1|2>] [-e] [-m] [-k] [-r]
  152.  
  153.  
  154.      EC                                                                      
  155.  
  156.  
  157.      Automatic Echo  Change. This  tells  Areafix  to  process  any  net/node
  158.      changes and/or  new echomail  areas. This  is what you would call normal
  159.      Areafix operation. Example:
  160.  
  161.                Areafix EC
  162.  
  163.  
  164.      FIND                                                                    
  165.  
  166.  
  167.      Command line  mode. Find  the echos  a  specific  node  is  listed  for.
  168.      Example:
  169.  
  170.                Areafix FIND 106/111
  171.  
  172.  
  173.      ADD                                                                     
  174.  
  175.  
  176.      Command line  mode. This instructs Areafix to add a specific node to one
  177.      or more echos. Example:
  178.  
  179.                Areafix ADD 1:106/111 Tech C_Echo Comm
  180.                Areafix ADD 106/111 all
  181.  
  182.  
  183.      DELETE                                                                  
  184.  
  185.  
  186.      Command line mode. This instructs Areafix to delete a specific node from
  187.      one or more echos. Example:
  188.  
  189.                Areafix DELETE 106/111 Tech C_Echo Comm
  190.                Areafix DELETE 1:106/111 all
  191.  
  192.      Areafix v1.29                                                     Page 5
  193.      ------------------------------------------------------------------------
  194.  
  195.  
  196.  
  197.      DROP                                                                    
  198.  
  199.  
  200.      Command line  mode. Areafix  will perform a single level deletion of all
  201.      links for  the requested  areas. Links with Areafix.Ctl Password entries
  202.      will receive  delete requests  addressed to  Areafix (-areaname).  Links
  203.      without Password  entries will  receive text  requests. The  Areafix.Ctl
  204.      PurgeRemove directive  controls deletion  of  messages  and  directories
  205.      orphaned by this operation.
  206.  
  207.                Areafix DROP Sysop Flame
  208.  
  209.  
  210.      REMOTEDELETEAREA                                                        
  211.  
  212.  
  213.      Command line mode. Areafix will remove specified areas as if remote area
  214.      delete requests  (AutoDelete or  ~areaname)  had  arrived.  Actions  are
  215.      determined by  the RemoteDeletion  series of  Areafix.Ctl directives. Be
  216.      careful with this one! Example:
  217.  
  218.                Areafix REMOTEDELETEAREA Sysop Flame
  219.  
  220.  
  221.      NOTIFY                                                                  
  222.  
  223.  
  224.      Notify will  send a  list of connected areas to all your the uplinks and
  225.      downlinks. Areafix.Ctl  directive NotifyHeader  defines a file to import
  226.      into each notification message sent. NotifyWithList will file-attach the
  227.      Echo_List filename to all notify messages. Example:
  228.  
  229.                Areafix NOTIFY
  230.  
  231.      If you'd  like to  exclude certain  nodes, see  the control file command
  232.      'NotifyExclude'.
  233.  
  234.      If you want to generate notification messages for only certain addresses
  235.      list those addresses on the command line:
  236.  
  237.                Areafix NOTIFY 270/1 101 211 273/715 6:62/2
  238.  
  239.  
  240.      QUERY                                                                   
  241.  
  242.  
  243.      This is  functionally the  same as the subject line switch '-q'. It will
  244.      return a list of echos that are available to a given node.
  245.  
  246.      Areafix v1.29                                                     Page 6
  247.      ------------------------------------------------------------------------
  248.  
  249.  
  250.  
  251.      <node>                                                                  
  252.  
  253.  
  254.      The Zone:Net/Node.Point for command line mode. If you leave out the zone
  255.      or zone and network number, the program will default to your own zone or
  256.      zone and net. Point defaults to 0. Example:
  257.  
  258.                Areafix FIND 1:106/111
  259.                Areafix FIND 106/111
  260.                Areafix FIND 111
  261.                Areafix FIND 270/101.8
  262.  
  263.  
  264.      <echo(s)>                                                               
  265.  
  266.  
  267.      The list of echos for ADD and DELETE modes. "All" is a wildcard areaname
  268.      that performs the operation on all areanames.
  269.  
  270.  
  271.      -c<Areafix.Ctl>                                                         
  272.  
  273.  
  274.      By default,  Areafix will  look for  the configuration  file by the name
  275.      'Areafix.Ctl' in the default directory. If you'd like to use a different
  276.      name or path, here's the place. Example:
  277.  
  278.                Areafix EC -cC:\Config\Areafix.Ctl
  279.  
  280.      Note: This  will override  the environment  variable. For information on
  281.      that, see the section entitled "Environment variable".
  282.  
  283.  
  284.      -a<Areas.Bbs>                                                           
  285.  
  286.  
  287.      Areafix  will  use  the  EchoMail  control  file  as  specified  in  the
  288.      configuration file  'Areafix.Ctl'. This  option can  be used to override
  289.      that. Example:
  290.  
  291.                Areafix EC -aC:\Config\Areas.Bbs
  292.  
  293.  
  294.      -h<1|2>                                                                 
  295.  
  296.  
  297.      A previous  version of  Areafix would delete 1.msg from each area if the
  298.      user specified  a '-r'  for "rescan"  on the  message subject  line.  If
  299.      you're running  with two high water marks, this can become a problem. By
  300.      default, Areafix  will reset high water mark #1 to do a rescan. Use this
  301.      option if you'd like to specify high water mark #2 instead. Example:
  302.  
  303.                Areafix EC -h2
  304.  
  305.      Areafix v1.29                                                     Page 7
  306.      ------------------------------------------------------------------------
  307.  
  308.  
  309.  
  310.      -e                                                                      
  311.  
  312.  
  313.      This switch  will reverse the effect of specifying or not specifying the
  314.      "NewAreasProcess" option  in the  Areafix configuration  file. In  other
  315.      words, if  you specify  "NewAreasProcess" =and=  the -e  switch, no  new
  316.      areas will  be processed.  On the  other  hand,  if  you  don't  specify
  317.      "NewAreasProcess" and  =do= specify the -e switch, the new areas will be
  318.      processed. Example:
  319.  
  320.                %         <
  321.                NewAreasProcess     <  Under this configuration, new
  322.                %         <  areas WILL NOT be processed.
  323.                          <
  324.  
  325.                Areafix EC -e       <
  326.  
  327.  
  328.  
  329.                %         <
  330.                % NewAreasProcess   <  Under this configuration, the new
  331.                %         <  areas WILL be processed.
  332.                          <
  333.  
  334.                Areafix EC -e       <
  335.  
  336.  
  337.      -r                                                                      
  338.  
  339.  
  340.      This switch forces a rescan of all areas added via a command line manual
  341.      add request. The areafix.ctl norescan parameter is ignored.
  342.  
  343.  
  344.      -m                                                                      
  345.  
  346.  
  347.      This switch  will cause  Areafix to  create a message to the listed node
  348.      when doing a FIND, ADD, DELETE, or QUERY. The letter 'k' can be added to
  349.      this switch  (as in  -mk) to  flag any  messages creates  as kill  after
  350.      sending. This has the same effect as -m -k. Example:
  351.  
  352.                Areafix FIND 106/111 -m
  353.  
  354.      This will  create a message to 106/111 informing him of which areas he's
  355.      active for.  This switch  will do  nothing when used in conjunction with
  356.      the EC and NOTIFY functions.
  357.  
  358.  
  359.      -k                                                                      
  360.  
  361.  
  362.      This tells  Areafix to  always flag  any messages  created as kill after
  363.      sending. Example:
  364.  
  365.      Areafix v1.29                                                     Page 8
  366.      ------------------------------------------------------------------------
  367.  
  368.  
  369.  
  370.                Areafix QUERY 1:106/111 -m -k
  371.  
  372.      Areafix v1.29                                                     Page 9
  373.      ------------------------------------------------------------------------
  374.  
  375.  
  376.  
  377.                                 CONFIGURATION FILE
  378.  
  379.  
  380.  
  381.      Address <Zone:Net/Node.Point>                             (Limit: 255)
  382.      Aka <Zone:Net/Node.Point>                                             
  383.  
  384.      Defines your  primary zone:net/node  number and  optionally  up  to  255
  385.      additional addresses.  All three  address components  (zone, net,  node)
  386.      =must= be provided.
  387.  
  388.      The first  Address or  Aka defined  is the  default or  primary  address
  389.      Areafix will  use  thruout  its  processing.  Additional  addresses  are
  390.      interpreted as "aka" addresses.
  391.  
  392.      The zone  from the  first directive will be used as the default zone for
  393.      all following control file processing and request processing.
  394.  
  395.  
  396.      Assume Zone                                                 (Limit: 1)
  397.      Assume Net                                                            
  398.  
  399.      This activates  either ZONE or ZONE:NET address assumption. This feature
  400.      tries to  be smart  about multi-zone  operations. When  either  type  of
  401.      address assumption  is active areafix uses the netmail "to" address only
  402.      until the  request is  validated against  your configured  addresses. At
  403.      that point your system identity is changed to match the caller's.
  404.  
  405.      If ZONE  assumption is  active Areafix  locates  the  first  address/aka
  406.      defined for  a matching  ZONE and  assumes  that  Zone:Net/Node  as  its
  407.      primary address.  NET assumption locates the first entry with a matching
  408.      ZONE:NET.
  409.  
  410.      From this  point on  all mail  Areafix generates  will ASSUME  the  full
  411.      ZONE:NET/NODE identity  of the  matching  address/aka.  If  no  matching
  412.      address is  located  Areafix  uses  the  first  Address/Aka  configured.
  413.      Example:
  414.  
  415.                Assume Net
  416.  
  417.  
  418.      PointNet                                                    (Limit: 1)
  419.  
  420.      This parameter  is provided  for compatibility with Areafix version 1.20
  421.      control files  and mail  handlers that  do not  use  4-D  addressing  in
  422.      Areas.Bbs handling.
  423.  
  424.      Defines your  private net  number for  limited  point  support.  NetMail
  425.      requests arriving  from one of your points (FMPT # or MSGID z:n/n.point)
  426.      will be changed to pointnet/point for processing. Example:
  427.  
  428.                PointNet 30500
  429.  
  430.      Areafix v1.29                                                    Page 10
  431.      ------------------------------------------------------------------------
  432.  
  433.  
  434.  
  435.      If your  address is  defined as  1:270/101 and your pointnet as 30500, a
  436.      request from  1:270/101.13 will  be 'remapped' to address 1:30500/13 for
  437.      request processing.
  438.  
  439.  
  440.      NetMail <path>                                              (Limit: 1)
  441.  
  442.      The full  path to  your where  your net messages are kept. This is where
  443.      Areafix searches for incoming requests and places its responses:
  444.  
  445.                C:\Msg\NetMail
  446.  
  447.  
  448.      ScanPath <path>                                             (Limit: 6)
  449.  
  450.      You can specify up to 3 additional paths to scan from. One example might
  451.      be your bad message directory (for creation of new areas):
  452.  
  453.                C:\Msg\Bad_Msgs
  454.  
  455.  
  456.      AreasFile <file>                 (Limit: 10 files totaling 2048 areas)
  457.  
  458.      This is  the name  of your  EchoMail control  file(s). It's important to
  459.      know that Areafix searches them sequentially when looking for a matching
  460.      area. It  will only add and delete nodes from the first match. New areas
  461.      will always be added to the last control file listed.
  462.  
  463.  
  464.      SystemType <type>                                           (Limit: 1)
  465.  
  466.      Defines the  format for  all defined  AreasFile lists. This controls how
  467.      Areafix interprets directory and passthrough information and creation of
  468.      new areas.  Valid system types are ConfMail, QM, Opus, PM, and QuickBBS.
  469.      It is  imperative that  you specify the proper control file type. If you
  470.      don't, you  run the  risk of  scrambling the format of the file. Be sure
  471.      it's set properly.
  472.  
  473.      Example: SystemType QM
  474.  
  475.  
  476.      Sysop <your name>                                           (Limit: 1)
  477.  
  478.      This is your name. It'll default to "SysOp" if not present. All response
  479.      and notification  messages generated by AreaFix will be addressed "from"
  480.      this name.
  481.  
  482.  
  483.      LogFile <file>                                              (Limit: 1)
  484.  
  485.      If you specify a file here, Areafix will keep a log of what it has done.
  486.      If you comment this out, there will be no log file.
  487.  
  488.      Areafix v1.29                                                    Page 11
  489.      ------------------------------------------------------------------------
  490.  
  491.  
  492.  
  493.      LogAllChanges
  494.  
  495.      This instructs Areafix to log any activities done in manual mode as well
  496.      as auto mode. The default is only do logging in auto mode.
  497.  
  498.  
  499.      SortNodes
  500.  
  501.      When Areafix  creates or  changes an area, all but the first node listed
  502.      (the feed) will be sorted if this option is enabled.
  503.  
  504.  
  505.      Format Short
  506.  
  507.      By default, Areafix will use the net/node form of nodes when updating an
  508.      area entry. The form is as such:
  509.  
  510.                106/111 106/112 106/113 22/4 22/5 60/1
  511.  
  512.      Optionally, you can tell Areafix to use the short from:
  513.  
  514.                106/111 112 113 22/4 5 60/1
  515.  
  516.      Keep in  mind, though,  that Opus  v1.03 does not support the short form
  517.      and thus  will not  work properly  with this setting! Other programs may
  518.      not support  it either.  QM, ConfMail,  and  QuickBBS  will  work  fine,
  519.      though.
  520.  
  521.      It should  be noted  that areafix  can always  READ the short form. This
  522.      option just  tells the  program whether or not to WRITE it that way. One
  523.      quick way  to convert  your control  to and  from the  short form is the
  524.      following...
  525.  
  526.      To make all nodes the 'short' form (net/node 999/999 can be any node you
  527.      don't list):
  528.  
  529.                %
  530.                Format Short
  531.                %
  532.  
  533.                Areafix ADD 999/999 all
  534.                Areafix DEL 999/999 all
  535.  
  536.      And, to convert it back to the normal form:
  537.  
  538.                %
  539.                % Format Short
  540.                %
  541.  
  542.                Areafix ADD 999/999 all
  543.                Areafix DEL 999/999 all
  544.  
  545.  
  546.      Format Long
  547.  
  548.      Areafix v1.29                                                    Page 12
  549.      ------------------------------------------------------------------------
  550.  
  551.  
  552.  
  553.      This command  directs areafix  to use the full zone:net/node format when
  554.      updating an area entry. The format is:
  555.  
  556.                1:106/111 1:106/112 1:106/113 1:22/4 1:22/5 1:60/1
  557.  
  558.      This format  wastes space  in your EchoMail control files and may not be
  559.      fully compatible with some toss/scan/edit programs.
  560.  
  561.  
  562.      Format Zone
  563.  
  564.      This command directs areafix to always use the full zone:net/node format
  565.      on the first entry for each area when updating an area entry. The format
  566.      is:
  567.  
  568.                1:106/111 106/112 106/113 22/4 22/5 60/1
  569.  
  570.      This format  wastes space  in your EchoMail control files and may not be
  571.      fully compatible with some toss/scan/edit programs.
  572.  
  573.  
  574.      Alias <name>                                               (Limit: 10)
  575.  
  576.      When looking  for messages to process, Areafix will look for the message
  577.      subject line  addressed to  "Areafix". You  can specify additional names
  578.      here. Example:
  579.  
  580.                Alias Autoecho
  581.  
  582.  
  583.      FileShare
  584.  
  585.      Activates support for MS-DOS (v3 and above) and OS/2 file sharing on all
  586.      control and  message files.  All opens will use the Deny None attribute.
  587.      Example:
  588.  
  589.                FileShare
  590.  
  591.  
  592.      NewAreasProcess
  593.  
  594.      This  command   tells  Areafix   to  automatically   create  new  areas,
  595.      subdirectories  (see  NewAreasNoDir),  and  control  file  entries  upon
  596.      encountering unknown  areas. Under  QuickBBS, the  subdirectory  is  not
  597.      created.
  598.  
  599.      For more  information, see  the '-e'  command line switch and the config
  600.      file option "QuickBBS RescanList".
  601.  
  602.  
  603.      NewAreasPath <path>                                         (Limit: 1)
  604.  
  605.      Areafix v1.29                                                    Page 13
  606.      ------------------------------------------------------------------------
  607.  
  608.  
  609.  
  610.      This is  the subdirectory  off which  the new areas are created. Areafix
  611.      will add  a backslash  if you  do not provide one. Both of the following
  612.      are the same as far as Areafix is concerned:
  613.  
  614.                NewAreasPath C:\Msg
  615.                NewAreasPath C:\Msg\
  616.  
  617.      Areafix will try to create area TEST as C:\Msg\TEST. If the subdirectory
  618.      cannot be created Areafix will try creating the subdirectory by removing
  619.      the last  character as  in C:\Msg\TES  and then  C:\Msg\TE  and  finally
  620.      C:\Msg\T. Areafix  will report  failure only when it has run through all
  621.      the (shortened) possibilities.
  622.  
  623.  
  624.      NewAreasNoDir
  625.  
  626.      If enabled  (not commented  out) this  will turn  off efforts  to create
  627.      subdirectories for  new areas.  NewAreasNoDir is  assumed for SystemType
  628.      QuickBBS operations.
  629.  
  630.  
  631.      NewAreaNumber <tag>                                         (Limit: 1)
  632.  
  633.      If you  have "NewAreasProcess"  enabled, and  an Opus  or QuickBBS style
  634.      control file,  then you  can tell  areafix which area number (or tag) it
  635.      should use  for the  new areas.  Keep in  mind that  under Opus, Areafix
  636.      will, by  default, mark  the area pass-through with the '#' sign between
  637.      the area name and node numbers.
  638.  
  639.      If you  don't specify  a <tag>, then it defaults to "99" under Opus, and
  640.      "P" under QuickBBS. Here's an example of a newly created area:
  641.  
  642.           Opus:
  643.  
  644.                <tag> <Subdirectory> <Area name> # <nodes>
  645.  
  646.           QuickBBS:
  647.  
  648.      <tag> <Area name> <nodes>
  649.  
  650.  
  651.      NewAreasNodes <nodes>                      (Limit: 255 on only 1 line)
  652.  
  653.      These are  the nodes to add when a new area is created. Areafix will add
  654.      the originating  node as  the first  address if  it is  not one  of your
  655.      configured addresses:
  656.  
  657.                NewAreasNodes 1:106/111 1:270/211
  658.  
  659.  
  660.      NewAreasCreate <nodes>                     (Limit: 255 on only 1 line)
  661.  
  662.      Areafix v1.29                                                    Page 14
  663.      ------------------------------------------------------------------------
  664.  
  665.  
  666.  
  667.      Normally, when  everything is  set correctly,  Areafix will create a new
  668.      area no  matter where the message originated from. Here you can instruct
  669.      Areafix to  only create  the new area if the message originated from one
  670.      of '<nodes>'. Looky here...
  671.  
  672.                NewAreasCreate 106/386 889
  673.  
  674.      In the  above example,  Areafix will  only create  the new  area if  the
  675.      message came  from either  106/386  or  106/889.  If  no  NewAreasCreate
  676.      addresses were defined any address could create a new area.
  677.  
  678.  
  679.      PurgeAreas
  680.  
  681.      Enables automatic EchoMail area Purge operations. A Purge occurs when an
  682.      incoming area  delete request  leaves only  one connection to a passthru
  683.      area. The  Purge operation  sends a delete request to the remaining feed
  684.      address, deletes  the area  from Areas.Bbs,  and records the purge data.
  685.      The  data  is  stored  in  the  filename  identified  by  the  PurgeFile
  686.      directive. This  stored information  is  used  to  determine  action  if
  687.      additional traffic arrives in a purged area.
  688.  
  689.      Unsolicited traffic  arriving from  a purged  address will be recognized
  690.      and deleted.  Add /  Delete requests  from any  address as  well as  new
  691.      traffic from  a non-purged  address will clear purged status for an area
  692.      and allow  normal operations  [request forward  and new  area create] to
  693.      resume.
  694.  
  695.      A global  Purge operation can be forced by adding a non-existant address
  696.      to all  areas (AreaFix  Add 9999/9999 All) and immediately removing that
  697.      address (AreaFix  Del 9999/9999  All). This  effectively  "touches"  all
  698.      areas defined in all defined area definition files.
  699.  
  700.  
  701.      PurgeFile <filename>                                        (Limit: 1)
  702.  
  703.      Identifies the  location and name (as a full filespec) of the Purge data
  704.      file. Information pertaining to automatic passthru area purge operations
  705.      is stored  in this  file. Information includes the area tag, purge date,
  706.      and last  feed address. This information is used to intercept additional
  707.      traffic arriving from the purged feed address and to recognize any valid
  708.      new "feeds" for affected echos.. The default filespec is AreaFix.Del.
  709.  
  710.      You can  make manual  entries in  the file. The format of entries in the
  711.      file is:
  712.  
  713.           P <purged (feed) node> <area name> <purge date as mm/dd/yyyy>
  714.  
  715.      Example: Purge_File O:\Areafix\Areafix.Del
  716.  
  717.  
  718.      PurgeRemove
  719.  
  720.      Areafix v1.29                                                    Page 15
  721.      ------------------------------------------------------------------------
  722.  
  723.  
  724.  
  725.      Triggers removal of message subdirectories for all purged message areas.
  726.      All files  are deleted from the subdirectory and the subdirectory itself
  727.      is  removed.   File  protection  and  subdirectories  within  a  message
  728.      subdirectory will  prevent  the  operation  from  being  completed.  The
  729.      Areafix program will not abort if this operation fails.
  730.  
  731.      Example: PurgeRemove
  732.  
  733.  
  734.      KeyDefault
  735.  
  736.      Defines the  default password Key string. This key string is assigned to
  737.      all addresses  without key  values. It  can be  used in  the same way as
  738.      ProtectDefault  and   LockDefault  to   reduce  Areafix.Ctl  maintenance
  739.      requirements. If  no KeyDefault  string is found AreaFix will default to
  740.      "KeyDefault ?*"  to allow  request forwarding  and idle  passthru purge.
  741.      Example:
  742.  
  743.                KeyDefault PAY@?
  744.  
  745.  
  746.      Password <net/node> <password> <accesslevel> [key [sysop]](Limit: none)
  747.  
  748.      In order  for a  node to have access to Areafix, it must have a password
  749.      set here.  The password  is then  entered on the message subject line of
  750.      the change  request message.  The access  level may  be from 0 to 32767,
  751.      with 32767  being the  highest, most  privileged level.  The  length  of
  752.      passwords should be limited to 8 characters, and is NOT case sensitive.
  753.  
  754.      An optional  security "key" can be defined for a node. Once access level
  755.      is validated  the key  will be  used in conjunction with an area LOCK to
  756.      further qualify  access fo  an EchoMail area. The key string can include
  757.      any or all of A-Z and 0-5.
  758.  
  759.      In addition  to the  32 optional key characters, the following privilege
  760.      option mask characters can be added to the field:
  761.  
  762.        .  KeyDefault key and privilege values will be assigned to this
  763.           address. Other flag values can be used with this flag.
  764.  
  765.        -  No key or privilege values assigned to this address.
  766.  
  767.        +  List privilege settings in response messages to this address
  768.  
  769.        ~  Allow remote deletion requests from this address
  770.  
  771.        @  Allow remote deletion request forwarding to this address
  772.  
  773.        ?  Allow requests from this address to be forwarded to uplinks
  774.  
  775.        *  Allow dead-end areas to be purged if this address is the feed
  776.  
  777.        &  Allow new areas to be created by this address
  778.  
  779.      Areafix v1.29                                                    Page 16
  780.      ------------------------------------------------------------------------
  781.  
  782.  
  783.  
  784.        #  Add this address to new areas created.
  785.  
  786.      An optional sysop name can follow the key/privilege field. Sysop name is
  787.      a positional  parameter --  it must  be the  fifth field on the Password
  788.      line. As such the key/privilege field must be specified if sysop name is
  789.      specified. '.' and '-' privilege option masks can be used in cases where
  790.      no explicit list is wanted or needed.
  791.  
  792.      Example:
  793.  
  794.                Password  106/111   Teddy     100       ABCDEF4@*
  795.                Password  270/211   Friend    101       ~@*?      Joe User
  796.                Password  13/13     Bug       24        .         Nobody Home
  797.  
  798.      Node 106/111  can add  any EchoMail area with a security level of 100 or
  799.      below and  with a  Lock string consisting of ABCDEF4 or ABC or ADF or 4.
  800.      Access to an area with a lock string of ABCDEFG4 would be denied because
  801.      the node does not have 'G' in the key string.
  802.  
  803.      Option  mask   values  @   and   *   are   also   active   to   indicate
  804.      RemoteDeletionForward is enabled and Purge is disabled for the node.
  805.  
  806.  
  807.      ProtectDefault
  808.  
  809.      Defines the  default protect  security level.  This  security  level  is
  810.      assigned to all EchoMail areas not named on Protect lines. This might be
  811.      useful in  a situation where most areas are a single level. In that case
  812.      ProtectDefault can  be used  for global  security level  assignment  and
  813.      Protect can be used for exceptions. Example:
  814.  
  815.                ProtectDefault 10
  816.  
  817.  
  818.      LockDefault
  819.  
  820.      Defines the default protect Lock string. This lock string is assigned to
  821.      all EchoMail  areas not  named on  Protect lines as well as all EchoMail
  822.      areas with no lock/privilege values assigned. It can be used in the same
  823.      way as  ProtectDefault and  KeyDefault to reduce Areafix.Ctl maintenance
  824.      requirements. Example:
  825.  
  826.                LockDefault PAY*
  827.  
  828.  
  829.      Protect <area> <minimum access level> [lock]             (Limit: none)
  830.  
  831.      The minimum  access level  can be  from 0  to 32767. A user must have at
  832.      least that  access level  or higher (listed with the 'password' command)
  833.      to add  the area.  He can always delete himself from the area, no matter
  834.      what the access level is.
  835.  
  836.      Areafix v1.29                                                    Page 17
  837.      ------------------------------------------------------------------------
  838.  
  839.  
  840.  
  841.      An optional  security "lock"  can be  defined for  an area.  Once access
  842.      level is  validated access to an area with a Lock string defined will be
  843.      limited to  nodes with a matching Key. An area with a lock string of ABC
  844.      can be accessed by keys ABC, ABC123, and ABCDEF4. Nodes with key strings
  845.      AC and AB will not be able to access the area.
  846.  
  847.      Example:
  848.  
  849.                Protect   qm_echo   10        
  850.                Protect   qm_beta   0         GREG
  851.  
  852.      If LockDefault  is set  to  PAY*  the first Protect line will be treated
  853.      internally as if entered as:
  854.  
  855.                Protect   qm_echo   10        PAY*
  856.  
  857.  
  858.      Echo_List <path>                                            (Limit: 1)
  859.  
  860.      When the  user specifies  a '-l'  subject line switch, Areafix will send
  861.      back the  first matching file (if one is specified) listed here. You may
  862.      use wildcards, the program will only send the first match, though.
  863.  
  864.  
  865.      NoRescan
  866.  
  867.      This switch will cause Areafix to ignore the message subject line switch
  868.      '-r'.
  869.  
  870.  
  871.      NoQuery
  872.  
  873.      This switch will cause Areafix to ignore the message subject line switch
  874.      '-q'.
  875.  
  876.  
  877.      QuickBBSRescanList <file>                                   (Limit: 1)
  878.  
  879.      Areafix  can   do  =kludge=  rescans  with  QuickBBS  when  operated  in
  880.      conjunction with  Fastfwd.Exe (available  from a  number of  BBSs). With
  881.      this option enabled, Areafix will create a batch file named as '<file>'.
  882.      The format being...
  883.  
  884.                FASTFWD A 1 <area number> <area name> <net/node>
  885.  
  886.      Each area  the user  wants to rescan will have an entry here. It is your
  887.      responsibility to delete the file after running it, otherwise it will be
  888.      appended to by Areafix.
  889.  
  890.      If you  need further  information, I  suggest you read the docs that are
  891.      included in Fastfwd.
  892.  
  893.  
  894.      RescanList <filename   command...>                          (Limit: 1)
  895.  
  896.      Areafix v1.29                                                    Page 18
  897.      ------------------------------------------------------------------------
  898.  
  899.  
  900.  
  901.      Directs Areafix to generate lines in a text file for each request for an
  902.      area rescan.  The first  parameter following  RescanList is the filename
  903.      that will  receive the rescan text lines. Anything else on the line will
  904.      be copied  to each  rescan text  line as  the command string and will be
  905.      followed by 5 fields. The format of lines in the file are ...
  906.  
  907.                <command...>  area  zone  net  node  point
  908.  
  909.  
  910.      ShowFeeds
  911.  
  912.      At the  end of  a return  message, Areafix  will list  which  echos  the
  913.      receiving node  is currently  setup for.  If you specify this option and
  914.      the receiving node is the FIRST node listed for the in the area, Areafix
  915.      will put  a '*'  (asterisk) beside  the area  (on the  return  message),
  916.      indicating he's the feed.
  917.  
  918.  
  919.      SaveProcessedMsgs
  920.  
  921.      By default,  Areafix will  delete the  inbound messages  after they have
  922.      been processed.  If you'd  rather save them, specify this option and the
  923.      program will  mark them  with the  "Received" flag  instead. The program
  924.      will skip any messages marked with that flag.
  925.  
  926.  
  927.      KillSent
  928.  
  929.      To mark  return messages as Kill after Sending, use this option. See the
  930.      command line "-k" option to override this.
  931.  
  932.  
  933.      ForceIntl
  934.  
  935.      Forces all  messages generated by AreaFix to include an ^AINTL line. The
  936.      line is ordinarily generated only when the destination zone differs from
  937.      the home  zone. This switch forces the INTL line regardless of origin or
  938.      destination zone.
  939.  
  940.  
  941.      AlertNode <net/node>                                        (Limit: 1)
  942.  
  943.      This option  allows you  to forward  a copy  of  return  messages  to  a
  944.      specific node.
  945.  
  946.  
  947.      NotifyHeader <file>                                         (Limit: 1)
  948.  
  949.      The default header message for the NOTIFY function is...
  950.  
  951.           "Please check the following list against your EchoMail control
  952.           file."
  953.  
  954.      Areafix v1.29                                                    Page 19
  955.      ------------------------------------------------------------------------
  956.  
  957.  
  958.  
  959.      If you'd like to use something different, then specify the file in which
  960.      your message is located.  Although not absolutely necessary, try to keep
  961.      the size of this file under about 4k.
  962.  
  963.  
  964.      NotifyExclude <nodes>                                      (Limit: 64)
  965.  
  966.      If you'd like to exclude certain nodes from the NOTIFY function, specify
  967.      them here.
  968.  
  969.  
  970.      NotifyWithEchoList
  971.  
  972.      This instructs  Areafix to  enclose what's  listed under 'EchoList' with
  973.      each NOTIFY message.
  974.  
  975.  
  976.      RemoteDeletion <node> <to> <password (subj)>               (Limit: 10)
  977.  
  978.      This  option  should  be  used  with  extreme  care.  It  gives  certain
  979.      individuals the  power to  delete any given area from your control file.
  980.      The program  will not,  however, remove  any files  from  the  messages'
  981.      subdirectory.
  982.  
  983.      Use this  option if you'd like someone (probably your net EC) to be able
  984.      to manage  your control file remotely. It can come in handy for deleting
  985.      non-distributed areas without sysop intervention.
  986.  
  987.      In order  for it  to work, the message must addressed to the name listed
  988.      in the  message '<to>'  field, with  the proper  password (subject line)
  989.      entry. The format for the body of the message is simply the area name(s)
  990.      to be deleted, the same way Areafix works.
  991.  
  992.  
  993.      RemoteDeletionNotify
  994.  
  995.      When an  area is discontinued, all listed nodes (that are not configured
  996.      to forward) will be sent a termination notice with this command enabled.
  997.  
  998.  
  999.      RemoteDeletionForward
  1000.  
  1001.      This is  both very  POWERFUL and very DANGEROUS. It can be a useful tool
  1002.      but must be used carefully and conservatively.
  1003.  
  1004.      When an  area is  discontinued via a RemoteDeletion request AreaFix will
  1005.      send automated  RemoteDeletion requests to all affected addresses rather
  1006.      than notifying them as with RemoteDeletionNotify.
  1007.  
  1008.      Areafix v1.29                                                    Page 20
  1009.      ------------------------------------------------------------------------
  1010.  
  1011.  
  1012.  
  1013.      If an  affected address  is listed  on a Protect configuration directive
  1014.      and the    @    privilege  flag  value  is  set  for  that  address  the
  1015.      RemoteDeletionNotify message  is replaced  by  a  message  addressed  to
  1016.      AutoDelete using  the password listed on the Protect line. If no Protect
  1017.      line exists  for an address the standard RemoteDeletionNotify message is
  1018.      generated.
  1019.  
  1020.      The end  result is  that each  system  in  the  distribution  chain  can
  1021.      configure whether  to accept  AutoDelete traffic, from whom, and whether
  1022.      and to  whom to  forward the  messages farther  along  the  distribution
  1023.      chain.
  1024.  
  1025.  
  1026.      RemoteDeletionRemove
  1027.  
  1028.      Triggers removal  of message  subdirectories for  all  remotely  deleted
  1029.      message areas.  All files  are deleted  from the  subdirectory  and  the
  1030.      subdirectory itself  is  removed.  File  protection  and  subdirectories
  1031.      within a  message subdirectory  will prevent  the operation  from  being
  1032.      completed.
  1033.  
  1034.      Example: RemoteDeletionRemove
  1035.  
  1036.  
  1037.      Forward_List <list file> <format> <node> <password> [from] (Limit: 10)
  1038.  
  1039.      In the  past, it  was necessary  for the sysop to manually request areas
  1040.      from his  uplink when one of his downlinks wanted something not carried.
  1041.      This feature solves that problem.
  1042.  
  1043.      You can  specify up  to 10 files that contain a list of what's available
  1044.      from your  uplink(s). The files will be searched in sequential order for
  1045.      the first  area name  match. Then,  Areafix will  send  an  Areafix  add
  1046.      message to  the listed  node requesting the area and add an entry to the
  1047.      Forward_Que file (see below).
  1048.  
  1049.      When the  area arrives,  Areafix will  create  the  new  area,  add  the
  1050.      original  requesting  node(s),  inform  them  that  the  area  has  been
  1051.      activated.
  1052.  
  1053.      Valid system  types are ConfMail, Opus, PM, QM, QuickBBS, and Text. Text
  1054.      format is  one area name per line. The area name must be the first field
  1055.      (word) on  the line. Additional information can follow the area name but
  1056.      will be ignored:
  1057.  
  1058.                COMM      PC Communications
  1059.                TECH      PC Technical
  1060.                ^Z
  1061.  
  1062.      The  optional   FROM  field  lets  you  define  a  network  address  (as
  1063.      Zone:Net/Node) that Areafix will use in requests it forwards to uplinks.
  1064.  
  1065.  
  1066.      Forward_Que <file>                                          (Limit: 1)
  1067.  
  1068.      Areafix v1.29                                                    Page 21
  1069.      ------------------------------------------------------------------------
  1070.  
  1071.  
  1072.  
  1073.      This is  the file  that holds  the request forwarding queue. The file is
  1074.      scanned every  time you  do an  "Areafix EC" function. If one or more of
  1075.      the areas  listed here  are found  in the  EchoMail  control  file,  the
  1076.      corresponding net/node will be added and notified.
  1077.  
  1078.      Keep in  mind, though, that Areafix treats the new addition the same way
  1079.      it would treat an inbound change request (in a message).
  1080.  
  1081.      Thus if  the node  no longer  has a  password, or  the area is protected
  1082.      higher than  his access  level, the  change request  will fail. Both the
  1083.      sysop (via  the log  file) and  the end  user (via  a message)  will  be
  1084.      informed.
  1085.  
  1086.      You may make manual additions to this file if you wish. The format is:
  1087.  
  1088.                <requesting (downlink) node> <uplink (feed) node> <area name>
  1089.                <date>
  1090.  
  1091.  
  1092.      A typical entry might go as follows:
  1093.  
  1094.                1:104/1 1:13/13 CHATTER 10/1/1991
  1095.  
  1096.      Areafix v1.29                                                    Page 22
  1097.      ------------------------------------------------------------------------
  1098.  
  1099.  
  1100.  
  1101.                             DOS ERRORLEVEL EXIT CODES
  1102.  
  1103.  
  1104.      Areafix will terminate with one of the following DOS errorlevels set:
  1105.  
  1106.        0  No messages were processed, or there were no changes made.
  1107.  
  1108.        1  Areafix messages were processed and/or NetMail was generated.
  1109.  
  1110.        2  New areas were created (and possibly Areafix messages were
  1111.           processed).
  1112.  
  1113.        3  Error during processing.
  1114.  
  1115.  
  1116.  
  1117.  
  1118.                               CONFIGURATION MAXIMUMS
  1119.  
  1120.  
  1121.      These are  the maximum values configured into Areafix. If a value is not
  1122.      listed the  maximum value  is determined  by available  memory  and  the
  1123.      combination of options and features selected.
  1124.  
  1125.           Max areas in all files.........2048
  1126.           Max line length in areas.bbs...4096
  1127.           Max forward que file slots.....none
  1128.           Max purge log file slots.......none
  1129.           Max nodes in all areas.........1024
  1130.           Max nodes per area.............1024
  1131.           Max password defines...........none
  1132.           Max protect defines............none
  1133.           Max new areas per execution.....128
  1134.           Max inbound messages per run.....50
  1135.           Max aka addresses...............255
  1136.           Max alias names..................10
  1137.           Max area control files...........10
  1138.           Max forward_list entries.........10
  1139.           Max forward list areas.........none
  1140.           Max purge list entries.........none
  1141.           Max remote delete requests.......10
  1142.           Max request scan paths............6
  1143.  
  1144.      Areafix v1.29                                                    Page 23
  1145.      ------------------------------------------------------------------------
  1146.  
  1147.  
  1148.  
  1149.                                ENVIRONMENT VARIABLE
  1150.  
  1151.  
  1152.      If you  intend  to  run  Areafix  from  a  path  other  than  where  the
  1153.      configuration file  is located and would rather not use the '-c' command
  1154.      line option,  you can  use the environment variable "AREAFIX=<pathname>"
  1155.      to locate the file. Example:
  1156.  
  1157.                C:\> Set AREAFIX=C:\Config\Areafix.Ctl
  1158.  
  1159.  
  1160.  
  1161.  
  1162.                                   PACKAGING LIST
  1163.  
  1164.  
  1165.                Areafix.Ctl..............Sample configuration file.
  1166.  
  1167.                Areafix.Prn..............Documentation.
  1168.  
  1169.                Areafix.Exe..............The executable.
  1170.  
  1171.                Areafix.Use..............Users Guide (for your users).
  1172.                .........................By Jeffrey Nonken (1:273/715)
  1173.  
  1174.  
  1175.  
  1176.  
  1177.                                    BUG REPORTS
  1178.  
  1179.  
  1180.      If  you   experience  a  problem  with  Areafix,  please  send  as  much
  1181.      information as  possible about  it to  George Peace  at 1:270/101.  Your
  1182.      report will  be  worked  on  as  available  time  permits.  Include  (if
  1183.      possible) art least the following:
  1184.  
  1185.        *  Your Areafix control file.
  1186.  
  1187.        *  Your EchoMail control file.
  1188.  
  1189.        *  The batch file you use to invoke Areafix.
  1190.  
  1191.        *  The messages (if any) it had problems with.
  1192.  
  1193.        *  Both your Config.Sys and Autoexec.Bat files.
  1194.  
  1195.        *  A full description of what happened.
  1196.  
  1197.      Areafix v1.29                                                    Page 24
  1198.      ------------------------------------------------------------------------
  1199.  
  1200.  
  1201.  
  1202.                                     DISCLAIMER
  1203.  
  1204.  
  1205.      This program  is guaranteed to do absolutely nothing. Use it at your own
  1206.      risk. No  warranty is  stated or  implied.  The  authors  shall  not  be
  1207.      responsible for  any  damages  resulting  from  it's  use,  directly  or
  1208.      indirectly.
  1209.  
  1210.      This program  is copyrighted and is the sole property of the authors. It
  1211.      may not be distributed in modified form or without documentation.
  1212.  
  1213.      You may use the software only after agreeing upon the above terms.